uniqueid2.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2026 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef UNIQUEID2_H
#define UNIQUEID2_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"




#define UNIQUEID2_REG_DTI                 0xE0
#define UNIQUEID2_REG_CDA                 0xC0
#define UNIQUEID2_REG_SWP                 0xA0
#define UNIQUEID2_REG_UID                 0x00
 // uniqueid2_reg



#define UNIQUEID2_DTI_DEFAULT             0xB1

#define UNIQUEID2_CDA_C2                  0x08
#define UNIQUEID2_CDA_DAL                 0x01

#define UNIQUEID2_SEL_ID_PAGE             0x00

#define UNIQUEID2_BLOCK_SIZE              65536
#define UNIQUEID2_BLOCK_ADDR_MASK         0xFFFF

#define UNIQUEID2_SWP_BP_QUARTER          0x00
#define UNIQUEID2_SWP_BP_HALF             0x02
#define UNIQUEID2_SWP_BP_THREE_QUARTER    0x04
#define UNIQUEID2_SWP_BP_ALL              0x06
#define UNIQUEID2_SWP_BP_MASK             0x06
#define UNIQUEID2_SWP_WPA                 0x08
#define UNIQUEID2_SWP_WPL                 0x01

#define UNIQUEID2_UID_LEN                 16
#define UNIQUEID2_UID_HEADER_ST_CODE      0x20
#define UNIQUEID2_UID_HEADER_BUS_PROTOCOL 0xE0
#define UNIQUEID2_UID_HEADER_DENSITY      0x12

#define UNIQUEID2_WC_WRITE_ENABLE         0x00
#define UNIQUEID2_WC_WRITE_DISABLE        0x01

#define UNIQUEID2_PAGE_SIZE               256
#define UNIQUEID2_ID_PAGE_SIZE            256
#define UNIQUEID2_MEMORY_SIZE             262144
#define UNIQUEID2_PAGE_OFFSET_MASK        0xFF
#define UNIQUEID2_BLOCK_OFFSET            16
#define UNIQUEID2_BLOCK_MASK              0x03

#define UNIQUEID2_DEVICE_ADDRESS_MEM      0x50
#define UNIQUEID2_DEVICE_ADDRESS_REG      0x58
 // uniqueid2_set



#define UNIQUEID2_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.wc  = MIKROBUS( mikrobus, MIKROBUS_PWM );
 // uniqueid2_map // uniqueid2

typedef struct
{
    // Output pins
    digital_out_t wc;                           
 
    // Modules
    i2c_master_t i2c;                           
 
    // I2C slave address
    uint8_t slave_address;                      
 
} uniqueid2_t;

typedef struct
{
    pin_name_t scl;                             
    pin_name_t sda;                             
    pin_name_t wc;                              
 
    uint32_t   i2c_speed;                       
    uint8_t    i2c_address;                     
 
} uniqueid2_cfg_t;

typedef enum
{
    UNIQUEID2_OK = 0,
    UNIQUEID2_ERROR = -1
 
} uniqueid2_return_value_t;


void uniqueid2_cfg_setup ( uniqueid2_cfg_t *cfg );

err_t uniqueid2_init ( uniqueid2_t *ctx, uniqueid2_cfg_t *cfg );

err_t uniqueid2_default_cfg ( uniqueid2_t *ctx );

err_t uniqueid2_write_memory ( uniqueid2_t *ctx, uint32_t address, uint8_t *data_in, uint16_t len );

err_t uniqueid2_read_memory ( uniqueid2_t *ctx, uint32_t address, uint8_t *data_out, uint32_t len );

err_t uniqueid2_write_register ( uniqueid2_t *ctx, uint8_t reg, uint8_t data_in );

err_t uniqueid2_read_register ( uniqueid2_t *ctx, uint8_t reg, uint8_t *data_out );

err_t uniqueid2_read_id_page ( uniqueid2_t *ctx, uint8_t offset, uint8_t *data_out, uint16_t len );

err_t uniqueid2_read_uid ( uniqueid2_t *ctx, uint8_t *uid );

void uniqueid2_set_wc_pin ( uniqueid2_t *ctx, uint8_t state );
 
#ifdef __cplusplus
}
#endif
#endif // UNIQUEID2_H
 // uniqueid2
 
// ------------------------------------------------------------------------ END